Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

make lint runs shellcheck on shell scripts as well #1345

Merged
merged 1 commit into from
Dec 14, 2023
Merged

make lint runs shellcheck on shell scripts as well #1345

merged 1 commit into from
Dec 14, 2023
+40 −0

Conversation

NotAName320
Copy link
Contributor

@NotAName320 NotAName320 commented Nov 26, 2023 •
edited
Loading

What this PR does / why we need it: This PR lets make lint run shellcheck on all shell scripts found recursively under images/capi, and adds an ensure-shellcheck.sh as well to automatically install the latest stable version of shellcheck.

Which issue(s) this PR fixes (optional, in fixes #(, fixes #<issue_number>, ...) format, will close the issue(s) when PR gets merged): Fixes #1327

Additional context
First PR to this repo! Sorry for the wait on this.

I've implemented the solution as the issue specified. Unfortunately, shellcheck has no fixing mode, so yet another library such as shfmt may be called for in order to implement corresponding functionality for make lint-fix. If called for, I could implement that as a part of this PR, but I just wanted to get a version out with the requested solution first. (it was also after I implemented the shellcheck solution that I realized that shfmt has a mode to print out formatting errors it detects as well—perhaps fully using that is the way to go?)

@linux-foundation-easycla Linux Foundation: EasyCLA
Copy link

linux-foundation-easycla bot commented Nov 26, 2023 •
edited
Loading

CLA Signed

The committers listed above are authorized under a signed CLA.

  • ✅ login: NotAName320 / name: Ray Chen (caae2b5)
  • ✅ login: mboersma / name: Matt Boersma (caae2b5)

@k8s-ci-robot
Copy link
Contributor

Welcome @NotAName320!

It looks like this is your first PR to kubernetes-sigs/image-builder 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/image-builder has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

@k8s-ci-robot k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Nov 26, 2023
@k8s-ci-robot
Copy link
Contributor

Hi @NotAName320. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@k8s-ci-robot k8s-ci-robot added cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 26, 2023
@k8s-ci-robot k8s-ci-robot added cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. and removed cncf-cla: no Indicates the PR's author has not signed the CNCF CLA. labels Nov 26, 2023
@mboersma
Copy link
Contributor

/ok-to-test

@k8s-ci-robot k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 27, 2023
@mboersma
Copy link
Contributor

/retest

mboersma
mboersma reviewed Nov 29, 2023
View reviewed changes
images/capi/Makefile Show resolved Hide resolved
images/capi/hack/ensure-shellcheck.sh Outdated Show resolved Hide resolved
images/capi/hack/ensure-shellcheck.sh Outdated Show resolved Hide resolved
mboersma
mboersma reviewed Dec 5, 2023
View reviewed changes
Copy link
Contributor

@mboersma mboersma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm

Could you squash the commits?

@k8s-ci-robot k8s-ci-robot added lgtm "Looks good to me", indicates that a PR is ready to be merged. do-not-merge/contains-merge-commits and removed lgtm "Looks good to me", indicates that a PR is ready to be merged. labels Dec 5, 2023
@NotAName320
Add an ensure shellcheck file
caae2b5 
make lint runs shellcheck on all shell files

ensure-shellcheck.sh checks for macos

Update images/capi/hack/ensure-shellcheck.sh

Co-authored-by: Matt Boersma <[email protected]>

remove redundant code

make lint runs shellcheck on sh files
@jsturtevant
Copy link
Contributor

/retest

mboersma
mboersma approved these changes Dec 13, 2023
View reviewed changes
Copy link
Contributor

@mboersma mboersma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

/lgtm
/approve

Thanks @NotAName320!

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Dec 13, 2023
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: mboersma

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Dec 13, 2023
@mboersma
Copy link
Contributor

/retest

Flake due to #1355.

@k8s-ci-robot k8s-ci-robot merged commit 25a576b into kubernetes-sigs:main Dec 14, 2023
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@mboersma mboersma mboersma approved these changes

@jsturtevant jsturtevant Awaiting requested review from jsturtevant

Assignees

@mboersma mboersma

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. ok-to-test Indicates a non-member PR verified by an org member that is safe to test. size/M Denotes a PR that changes 30-99 lines, ignoring generated files.
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

make lint should also check shell scripts
4 participants
@NotAName320 @k8s-ci-robot @mboersma @jsturtevant